home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / database / auror120.zip / AREF.DOC < prev    next >
Text File  |  1994-01-14  |  18KB  |  406 lines
  1.  
  2.  
  3.   T h e   A u r o r a   E d i t o r   Q u i c k   R e f e r e n c e
  4.   ─────────────────────────────────────────────────────────────────
  5.  
  6.   This Quick Reference briefly summarizes all The Aurora Editor library
  7.   functions documented in The Aurora Editor Users Guide (A.DOC). For
  8.   documentation on native macro language functions, see "The Aurora
  9.   Macro Language Guide".
  10.  
  11.   Library functions are listed by category. Each library function is
  12.   followed by the default key definition (if any), and a brief
  13.   description. User-specified arguments to library functions are
  14.   enclosed in [bracket] characters.
  15.  
  16.  
  17.   File
  18.   ────
  19.  
  20.     newf                   <Ctrl-N>          new edit window
  21.     askopen                <Alt-E>           open prompt
  22.     askopenins             <Alt-I>           insert file prompt
  23.     askopenb                                 open binary prompt
  24.     openlast               <Alt-Z>           open last window
  25.     wrdlod CSetB           <Ctrl-]>          open file at cursor
  26.     refresh                                  refresh file from disk
  27.     askname                <Alt-N>           rename prompt
  28.     name [filename]                          rename filename
  29.     open [filespec] [options]                open filename/directory
  30.     opena [filename]                         open a .A file
  31.     save                   <F3>              save current file
  32.     save [filename]                          save filename
  33.     asksaveas                                save-as prompt
  34.  
  35.     fmgr                   <F4>              display file manager
  36.  
  37.     quit %p                                  close file & window
  38.     gquit %p               <Alt-X>           close all windows
  39.     quit %f                                  save file and close window
  40.     gquit %f                                 save file and close all windows
  41.  
  42.     wquit %p               <Ctrl-K-Q>        close window
  43.     fquit %p               <Alt-Q>           close file
  44.     fquit %f               <Ctrl-X>          save and close file
  45.  
  46.     fnex                   <Ctrl-Del>        next file
  47.     fpre                   <Ctrl-Ins>        prev file
  48.     flis                   <Alt-Hyphen>      display file list
  49.  
  50.     about                                    display about box
  51.  
  52.     hlp [major] [minor]                      display User's Guide
  53.     qref                   <Shift-F1>        display Quick Reference
  54.  
  55.  
  56.   Window
  57.   ──────
  58.  
  59.     wlis                   <Alt-W>           display window list
  60.     wres                                     restore window
  61.     wkey                   <Ctrl-F5>         move/size window
  62.     wkey %p                <Ctrl-F6>         pan video background
  63.     wmin                                     minimize window
  64.     wmax                   <Ctrl-Z>          maximize window
  65.     wnex                   <Ctrl-A>          next window
  66.     wpre                                     prev window
  67.  
  68.     wcopy                  <Ctrl-C>          copy window
  69.     wspl %h                <Alt-H>           split window horizontal
  70.     wspl %v                <Alt-V>           split window vertical
  71.  
  72.     wcasc                  <Shift-F5>        cascade windows
  73.     wtileh                 <Shift-F4>        tile windows horizontally
  74.     wtilev                 <Shift-F3>        tile windows vertically
  75.  
  76.     wtool                  <Ctrl-F8>         display tool bar
  77.     winsty                 <Ctrl-F7>         change window style
  78.     wppt                                     change prompt style
  79.  
  80.     wrtv %p                <cursorup>        retrieve prev prompt
  81.     wrtv %n                <cursordown>      retrieve next prompt
  82.  
  83.  
  84.   Menu
  85.   ────
  86.  
  87.     menb                   <Esc>, <F10>      to last menu bar item
  88.     men                    <Alt-F10>         to last pull-down menu
  89.     menh                   <F1>              help pull-down
  90.     men2                   <Alt-T>           to last tool bar control
  91.     mens [submenu]                           display submenu
  92.  
  93.  
  94.   Cursor Movement
  95.   ───────────────
  96.  
  97.     left                   <cursorleft>      move cursor left
  98.     right                  <cursorright>     move cursor right
  99.     up                     <cursorup>        move cursor up
  100.     down                   <cursordown>      move cursor down
  101.  
  102.     cptop                  <Ctrl-Home>       to page top
  103.     cpbot                  <Ctrl-End>        to page bottom
  104.     cmov @ 1               <Ctrl-PgUp>       to file top
  105.     cmov @ (qtexend)       <Ctrl-PgDn>       to file bottom
  106.     cmov [x] [y]                             to [x], [y] (abs or rel)
  107.  
  108.     chome                  <Home>            to column one
  109.     ceol                   <End>             to end of line
  110.     clast                  <Ctrl-Hyphen>     to last cursor position
  111.     ctab                   <Tab>             tab right
  112.     ctab %l                <Shift-Tab>       tab left
  113.     cwrd %l CSet           <Ctrl-Left>       find left word
  114.     cwrd %r CSet           <Ctrl-Right>      find right word
  115.  
  116.     ladj @ -1              <Keypad-5>        center cursor
  117.     ladj @  1              <Ctrl-F9>         scroll to page top
  118.     ladj @ (qwinp @ %y1d)  <Ctrl-F10>        scroll to page bottom
  119.  
  120.     askbset                                  set bookmark prompt
  121.     bset                   <Ctrl-2>          quick bookmark
  122.     bset [bookmark]                          set bookmark
  123.     askbget                                  go to bookmark prompt
  124.     bget                   <Ctrl-6>          to previous bookmark
  125.     bget [bookmark]                          go to bookmark
  126.  
  127.     askglin                <Ctrl-J>          go to line prompt
  128.     glin [line]                              go to line
  129.     askgcol                                  go to column prompt
  130.     gcol [column]                            go to column
  131.     mloc @ %t              <Ctrl-B>          find top of block
  132.     mloc @ %b                                find bottom of block
  133.     cfld                   <Alt-7>           go to next fold
  134.     cfld %r                                  go to prev fold
  135.  
  136.     finm                   <Alt-F3>          find matching char
  137.     finc                   <Alt-F7>          go to compiler error
  138.  
  139.  
  140.   Scrolling
  141.   ─────────
  142.  
  143.     scry (- (ypagsiz))     <PgUp>            scroll up
  144.     scry (ypagsiz)         <PgDn>            scroll down
  145.     scry (- (/ (ypagsiz) 2))                 scroll up 1/2 page
  146.     scry (/ (ypagsiz) 2)                     scroll down 1/2 page
  147.     scry -1                <Ctrl-Up>         scroll up one line
  148.     scry  1                <Ctrl-Down>       scroll down one line
  149.  
  150.     scrx (- (xpagsiz))     <F7>              scroll left
  151.     scrx (xpagsiz))        <F8>              scroll right
  152.  
  153.  
  154.   Modifying Text
  155.   ──────────────
  156.  
  157.     cmtog                  <Ins>             toggle insert mode
  158.     enteredit              <Enter>           enter key
  159.     delch                  <Del>             delete character
  160.     baksp                  <Backspace>       delete left character
  161.  
  162.     undo                   <Ctrl-U>          undo last change
  163.     undo %r                <Ctrl-Y>          redo last change
  164.  
  165.     lins %a                <Ctrl-Enter>      insert line w/autoindent
  166.     lins %c                                  insert line
  167.     ldel                   <Ctrl-Backspace>  delete line
  168.     lspl                   <Alt-S>           split line
  169.     ljoin                  <Alt-J>           join line
  170.  
  171.     leol                   <F6>              erase to end of line
  172.     leol %l                <Alt-F6>          erase to beginning of line
  173.     wrddel CSet            <Ctrl-T>          delete right word
  174.     wrdcas [options] [CSet]                  change case of a word
  175.     ldup                   <Alt-4>           duplicate line
  176.     lswp                   <Alt-5>           swap line
  177.     lcen                   <Alt-6>           center line
  178.  
  179.     lcom                   <Alt-F1>          comment/uncomment line (//)
  180.     lcom [string1] [string2]                 comment/uncomment line
  181.     lit                    <Ctrl-[>          enter literal character
  182.     wasc                   <Alt-=>           display ascii chart
  183.     txt [string]                             enter a string at the cursor
  184.     stamp                  <Ctrl-K-T>        date/time stamp
  185.     exptab                 <Ctrl-K-X>        expand tabs
  186.  
  187.  
  188.   OS Commands
  189.   ───────────
  190.  
  191.     askoscmd %ck           <Alt-F9>          DOS command prompt
  192.     os [cmd] [options]                       execute DOS command
  193.     askoscap               <Alt-F8>          DOS capture prompt
  194.     oscap [cmd] [options]                    capture DOS command output
  195.     osshell                <F9>              exit to DOS
  196.  
  197.  
  198.   Marking
  199.   ───────
  200.  
  201.     mset %l                <Alt-L>           mark line
  202.     mset %r                <Alt-B>           mark column
  203.     mset %s                <Alt-A>           mark character
  204.     wrdmrk CSet            <Alt-1>           mark word
  205.     meol                   <Alt-2>           mark to end of line
  206.     mpgh %tb               <Alt-3>           mark paragraph
  207.  
  208.     mdes                   <Alt-U>           unmark
  209.  
  210.  
  211.   Block
  212.   ─────
  213.  
  214.     mcpy                   <Alt-C>           copy block
  215.     mcpyp                  <Alt-C>           copy block to prompt
  216.     mmov %o                <Alt-O>           overlay block
  217.     mmov                   <Alt-M>           move block
  218.     mmov %of               <Ctrl-M>          move block over
  219.     mdel                   <Alt-D>           delete block
  220.     mshf  1                <Shift-F8>        indent block
  221.     mshf -1                <Shift-F7>        unindent block
  222.  
  223.     askmfill               <Ctrl-K-F>        fill block prompt
  224.     mrfl %b                <Alt-R>           reflow block
  225.     mrfl %br               <Alt-Y>           reflow & right justify block
  226.     msave                  <Ctrl-K-S>        save block
  227.     msave %a                                 append block
  228.     msrt                   <Ctrl-K-O>        sort block
  229.     mcase %l                                 change block to lower case
  230.     mcase %u               <Ctrl-K-U>        change block to upper case
  231.     mcase %ul                                flip case of block
  232.  
  233.     mjust %l                                 left justify block
  234.     mjust %c               <Ctrl-K-C>        center block
  235.     mjust %r                                 right justify block
  236.  
  237.     print %m               <Alt-P>           print block
  238.  
  239.  
  240.   Clipboard
  241.   ─────────
  242.  
  243.     clpcpy %d              <Grey->           cut
  244.     clpcpy %ad             <Ctrl-Grey->      cut append
  245.     clpcpy                 <Grey+>           copy
  246.     clpcpy %a              <Ctrl-Grey+>      copy append
  247.  
  248.     clppst                 <Grey*>           paste
  249.     clppst %o              <Ctrl-Grey*>      paste over
  250.  
  251.     clpclr                 <Ctrl-Grey/>      clear clipboard
  252.     askclp                                   clipboard name prompt
  253.  
  254.  
  255.   Folding
  256.   ───────
  257.  
  258.     lfld %b                <Alt-8>           fold next line
  259.     lfld %t                                  fold prev line
  260.  
  261.     mfld %f                <Alt-F>           fold block
  262.     mfld %uaf                                fold block flat
  263.  
  264.     lfld %u                <Alt-G>           unfold line
  265.     lfld %ua                                 unfold line flat
  266.     lfld %bs               <Alt-9>           unfold next line
  267.     lfld %ts                                 unfold prev line
  268.  
  269.     mfld %u                                  unfold block
  270.     mfld %ua                                 unfold block flat
  271.     mflda %ua              <Alt-0>           unfold all
  272.  
  273.  
  274.   Search and Replace
  275.   ──────────────────
  276.  
  277.     askfind                <Ctrl-F>, <F5>    find prompt
  278.     askrpl                 <Ctrl-G>          replace prompt
  279.     search [string]                          find/replace
  280.     finl                   <Ctrl-L>          do last find/replace
  281.     askscan                <Ctrl-S>          scan prompt
  282.  
  283.  
  284.   Printing
  285.   ────────
  286.  
  287.     print                  <Ctrl-P>          print
  288.     print %d               <Ctrl-P>          print file mgr contents
  289.     print %m               <Alt-P>           print block
  290.     prtstr [string]                          print string
  291.     askprtset                                print settings prompt
  292.  
  293.     prtfil [filename]                        print filename
  294.  
  295.  
  296.   Settings
  297.   ────────
  298.  
  299.     wmwrap                 <Ctrl-W>          word wrap toggle
  300.     wmautoi                                  autoindent toggle
  301.     wmvtab                                   variable tabs toggle
  302.     wmsmtab                                  smart tabs toggle
  303.     wmmat                                    match character toggle
  304.     wmbak                                    file backup toggle
  305.     wmtran                 <Alt-F4>          text translation toggle
  306.     wmdraw                 <Ctrl-D>          line draw toggle
  307.     sdraws [0/1/2/3/4]                       line draw style
  308.  
  309.     asktabw                                  tab width prompt
  310.     asktabv                                  variable tabs prompt
  311.     asklmrg                                  left margin prompt
  312.     askrmrg                                  right margin prompt
  313.     askind                                   paragraph indent prompt
  314.     askdefx                                  file extensions prompt
  315.     askbin                                   binary line length prompt
  316.     askdlm                                   line delimiter prompt
  317.  
  318.     vfont %t               <Ctrl-F1>         toggle video mode
  319.     vfont [columns] [rows]                   change video mode
  320.  
  321.     setsav                                   save current settings
  322.     setres                                   restore settings
  323.  
  324.  
  325.   Key Macros
  326.   ──────────
  327.  
  328.     krec                   <Ctrl-R>          record key macro toggle
  329.     kplay                  <Ctrl-E>          play scrap key macro
  330.     kdel                   <Ctrl-I>          erase scrap key macro
  331.     kdel %a                                  erase all key macros
  332.     askkopen                                 key macro open prompt
  333.     kopen [filename]                         open key macro file
  334.     askksav                                  key macro save prompt
  335.     ksav [filename]                          save key macros to filename
  336.     kcat                                     assign scrap key macro to key
  337.  
  338.  
  339.   Macros
  340.   ──────
  341.  
  342.     opena %acfg                              display configuration (ACFG.A)
  343.     opena %akbd                              display key defs (AKBD.A)
  344.     opena %amen                              display menu defs (AMEN.A)
  345.     opena %atrn            <Alt-F5>          display translate defs (ATRN.A)
  346.  
  347.     askmcmd                <Ctrl-V>          macro command prompt
  348.     askmrun                                  run macro prompt
  349.     askminc                                  include macro prompt
  350.     askmcom                                  compile macro prompt
  351.  
  352.     mcmd [expression]                        evaluate macro expression
  353.     mrun [filename]                          evaluate macro file
  354.     minc [filename]                          include macro file
  355.     mcom [filename]                          compile macro file
  356.  
  357.  
  358.   Miscellaneous Functions
  359.   ───────────────────────
  360.  
  361.     say [message] [options]                  display message on title bar
  362.     mbox [title] [message] [options]         display message box
  363.     ask [prompt] [title] [width]             user prompt for string
  364.     askbox [title] [options]                 menu box prompt
  365.     keyx [key prefix]                        define compound key prefix
  366.     askkrep                <Ctrl-Q-Q>        repeat last key command
  367.     dn                                       get fmgr filename at cursor
  368.  
  369.     moubegmrk [x] [y] [options]              begin mouse mark
  370.     moumovmrk [x] [y]                        extend mouse mark
  371.     mouendmrk [x] [y]                        end mouse mark
  372.  
  373.     winsizt [l] [t] [r] [b] [reps] [options]  resize current window
  374.     qwrd [char set]                          get the word at the cursor
  375.     qwinmin                                  test if window is minimized
  376.     qwinmax                                  test if window is maximized
  377.     qtimdat                                  return date/time
  378.  
  379.  
  380.   File Manager
  381.   ────────────
  382.  
  383.     fpar                   <Ctrl-Backspace>  parent directory
  384.     fopen                  <Enter>,<e>,<o>,<z>  open file/directory
  385.     fopen %b               <b>               open binary file
  386.     fopenk                 <k>               open key macro file
  387.     fmov                   <m>               move file
  388.     fcpy                   <c>               copy file
  389.     fdel                   <d>, <Del>        delete file
  390.     fren                   <n>               rename file
  391.     frun %c                <r>               run program/batch file
  392.     fprt                   <p>               print file
  393.     fatt                   <a>               change file attributes
  394.     ftch                   <t>               touch file
  395.     fcred                                    create new directory
  396.  
  397.     fmtog                  <Space Bar>       mark/unmark file
  398.     fmrk                   <Alt-M>           mark all files
  399.     fumrk                  <Alt-U>           unmark all
  400.  
  401.     fsrt %n                <Alt-N>           sort by name
  402.     fsrt %s                <Alt-S>           sort by size
  403.     fsrt %d                <Alt-D>           sort by date
  404.     fsrt %o                <Alt-O>           no sort (DOS order)
  405.  
  406.